Edit Task: SetResourceDetails ResourceSetupModes
Description
The SetupModes attribute under EditTask defines the usable resource state setup modes for the specified resource for all of the task's possibilities.
Parameters
Parameter | Description |
---|---|
ResourceName | A string of text of the resource that is being defined within the command. |
Applies | A Boolean value that determines whether body state modes are applicable. |
Modes | A string of text of a comma delimited list of usable body modes. Empty string is allowed if the Applies value is false. A mode name specified that is not already part of the predefined modes for the resource will be added dynamically to the associated resource's capacity state definition permanently as the next free enumerated mode index. |
Examples
Set usable modes during setup for all possibilities containing ResA in TaskA
PATCH api/task/TaskA
Body:
{
"SetResourceDetails" : {
"ResourceName" : "ResA",
"SetupModes" : {
"Applies" : "TRUE",
"Modes" : "Blue,Red,Green" }
}
}